feat: enforce generation of docs for commands #112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>
f0rmiga
force-pushed
the
f0rmiga/enforce-docs-commands
branch
from
79fa926
to
4a7f484
Compare
mattem
approved these changes
Jan 12, 2022
There was a problem hiding this comment.
Not going to block, but I feel the implementation / naming confuses me a little. As in, it outputs text that has doc and structure of a bzl file, but requires the output to be redirected to a file - what else would someone do with it?
Perhaps if it was named generate_bzl_command_list or something more specific? I dunno 🤷
Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>
Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Whenever we create a new top-level command, the feature being introduced in this PR will keep the docs up-to-date.
This will avoid future mistakes e.g. the one that e4a9dd4 fixes.